com.highdeal.pnr.hci
Class TranslationTableModel

java.lang.Object
  com.highdeal.pnr.hci.TranslationTableModel

All Implemented Interfaces:

ITagNameProvider, XMLMarshallable, ICatalogObject

public class TranslationTableModel
extends java.lang.Object
implements XMLMarshallable, ICatalogObject, ITagNameProvider

This Java class represents a translation table as seen when it comes from the back-end database system.

The order of the rows in a translation table is very important and determines the output result when searching in the translation table using any of the following criteria: STARTS_WITH, ENDS_WITH, or CONTAINS or IS_CONTAINED. Ensure that any table that you create or modify are sorted in the correct order.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="translationTable">
   <xs:complexType>
    <xs:sequence>
     <xs:element ref="inAttribute" minOccurs="0" maxOccurs="5"/>
     <xs:element ref="outAttribute" minOccurs="0" maxOccurs="15"/>
     <xs:element ref="tableInstance" minOccurs="0" maxOccurs="1"/>
     <xs:element ref="tableInstanceChronology" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="owner" type="xs:string" use="required"/>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="reference" type="xs:string"/>
     <xs:attribute name="useDates" type="xs:boolean" default="false" />
     <xs:attribute name="disallowDuplicateInputs" type="xs:boolean" default="false" />
   </xs:complexType>
 </xs:element>
 <xs:element name="tableInstanceChronology">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="chronology" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

static int	CONTAINS Contains comparison operator.
static int	ENDS_WITH Ends with comparison operator.
static int	EQUALS Equality comparison operator.
static int	IS_CONTAINED Is_contained comparison operator.
static int	MAX_IN_ATTRIBUTES The maximum input attribute count.
static int	MAX_OUT_ATTRIBUTES The maximum output attribute count.
static int	STARTS_WITH Starts with comparison operator.

Constructor Summary

TranslationTableModel()
Builds an empty TranslationTableModel.

TranslationTableModel(java.lang.String code, java.lang.String description)
Builds a TranslationTableModel from a code and a description.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addInAttribute(InAttributeModel attribute) Adds an in attribute.
void	addOutAttribute(OutAttributeModel attribute) Adds an out attribute.
boolean	checkValidity() Returns true if the translation table is valid.
java.lang.String	getCode() Gets the code.
java.lang.String	getDescription() Gets the description.
boolean	getDisallowDuplicateInputs() Returns true if the translation table disallows duplicate input attributes.
java.util.HashMap<java.lang.Integer,java.lang.Integer>	getDuplicateInputsMap() Returns a map which keys and values are rows indexes.
java.util.Vector<InAttributeModel>	getInAttributes() Gets the in attributes.
TranslationInstanceModel	getInstance() Gets the instance.
ChronologyModel	getInstanceChronology() Gets the instance chronology.
java.util.Vector<OutAttributeModel>	getOutAttributes() Gets the out attributes.
java.lang.String	getOwner() Gets the owner.
java.lang.String	getReference() Gets the reference.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
boolean	getUseDates() Returns true if the translation table uses validity dates, false otherwise.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	removeInAttribute(int index) Removes an in attribute.
void	removeOutAttribute(int index) Removes an out attribute.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCode(java.lang.String c) Sets the code.
void	setDescription(java.lang.String d) Sets the description.
void	setDisallowDuplicateInputs(boolean disallow) Sets whether the translation table disallows duplicate input attributes.
void	setInAttributes(java.util.Vector<InAttributeModel> inAttributes) Sets the in attributes.
void	setInstance(TranslationInstanceModel i) Sets the instance.
void	setOutAttributes(java.util.Vector<OutAttributeModel> outAttributes) Sets the out attributes.
void	setOwner(java.lang.String p) Sets the owner.
void	setReference(java.lang.String r) Sets the reference.
void	setUseDates(boolean use) Sets whether the translation table use validity dates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EQUALS

public static final int EQUALS

Equality comparison operator.

See Also:

Constant Field Values

STARTS_WITH

public static final int STARTS_WITH

Starts with comparison operator.

See Also:

Constant Field Values

ENDS_WITH

public static final int ENDS_WITH

Ends with comparison operator.

See Also:

Constant Field Values

CONTAINS

public static final int CONTAINS

Contains comparison operator.

See Also:

Constant Field Values

IS_CONTAINED

public static final int IS_CONTAINED

Is_contained comparison operator.

See Also:

Constant Field Values

MAX_OUT_ATTRIBUTES

public static final int MAX_OUT_ATTRIBUTES

The maximum output attribute count.

See Also:

Constant Field Values

MAX_IN_ATTRIBUTES

public static final int MAX_IN_ATTRIBUTES

The maximum input attribute count.

See Also:

Constant Field Values

Constructor Detail

TranslationTableModel

public TranslationTableModel()

Builds an empty TranslationTableModel.

TranslationTableModel

public TranslationTableModel(java.lang.String code,
                             java.lang.String description)

Builds a TranslationTableModel from a code and a description.

Parameters:

code - The code

description - The description

Method Detail

getReference

public java.lang.String getReference()

Gets the reference.

Returns:

The reference

setReference

public void setReference(java.lang.String r)

Sets the reference.

Parameters:

r - The reference

getInstance

public TranslationInstanceModel getInstance()

Gets the instance.

Returns:

The instance

setInstance

public void setInstance(TranslationInstanceModel i)

Sets the instance.

Parameters:

i - The instance

getCode

public java.lang.String getCode()

Gets the code.

Returns:

The code

setCode

public void setCode(java.lang.String c)

Sets the code.

Parameters:

c - The code

getDescription

public java.lang.String getDescription()

Gets the description.

Returns:

The description

setDescription

public void setDescription(java.lang.String d)

Sets the description.

Parameters:

d - The description

setInAttributes

public void setInAttributes(java.util.Vector<InAttributeModel> inAttributes)

Sets the in attributes.

Parameters:

inAttributes - A vector of InAttributeModel representing the in attributes

getInAttributes

public java.util.Vector<InAttributeModel> getInAttributes()

Gets the in attributes.

Returns:

A vector of InAttributeModel representing the in attributes

setOutAttributes

public void setOutAttributes(java.util.Vector<OutAttributeModel> outAttributes)

Sets the out attributes.

Parameters:

outAttributes - A vector of OutAttributeModel representing the out attributes

getOutAttributes

public java.util.Vector<OutAttributeModel> getOutAttributes()

Gets the out attributes.

Returns:

A vector of OutAttributeModel representing the out attributes

addInAttribute

public void addInAttribute(InAttributeModel attribute)

Adds an in attribute.

Parameters:

attribute - The in attribute to add

removeInAttribute

public void removeInAttribute(int index)

Removes an in attribute.

Parameters:

index - The index of the in attribute to remove

addOutAttribute

public void addOutAttribute(OutAttributeModel attribute)

Adds an out attribute.

Parameters:

attribute - The out attribute to add

removeOutAttribute

public void removeOutAttribute(int index)

Removes an out attribute.

Parameters:

index - The index of the out attribute to remove

getOwner

public java.lang.String getOwner()

Gets the owner.

Specified by:

getOwner in interface ICatalogObject

Returns:

The owner

setOwner

public void setOwner(java.lang.String p)

Sets the owner.

Parameters:

p - The owner

getInstanceChronology

public ChronologyModel getInstanceChronology()

Gets the instance chronology.

Returns:

A instance chronology with TranslationInstanceModel elements

getUseDates

public boolean getUseDates()

Returns true if the translation table uses validity dates, false otherwise.

Returns:

true if the translation table uses validity dates, false otherwise

setUseDates

public void setUseDates(boolean use)

Sets whether the translation table use validity dates.

Parameters:

use - true if the translation table use validity dates, false otherwise

getDisallowDuplicateInputs

public boolean getDisallowDuplicateInputs()

Returns true if the translation table disallows duplicate input attributes.

Duplicate input attributes exist when two rows, which are valid during a common period of time, have same input attributes.

When duplicate input attributes are not allowed, then an exception is thrown by translation table creation or modification operations if such duplicate exists in the passed translation table.

Returns:

true if the translation table disallows duplicate input attributes

setDisallowDuplicateInputs

public void setDisallowDuplicateInputs(boolean disallow)

Sets whether the translation table disallows duplicate input attributes.

Parameters:

disallow - Indicates whether the translation table must disallow duplicate input attributes

See Also:

getDisallowDuplicateInputs()

checkValidity

public boolean checkValidity()

Returns true if the translation table is valid.

Returns:

true if the translation table is valid, false otherwise

getDuplicateInputsMap

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getDuplicateInputsMap()

Returns a map which keys and values are rows indexes. Each key refers to a row which has duplicate input attributes with respect to the row refered by the corresponding value.

Returns:

A map of row indexes

See Also:

getDisallowDuplicateInputs()

getTagName

public java.lang.String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Specified by:

getTagName in interface ITagNameProvider

Returns:

The XML tag name

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into